Add Button Controlled LEDs tutorial under ESPHome Starter Kit > Automations#852
Conversation
…ations Introduces a new Automations group with a first GUI-builder tutorial that walks through wiring the Button module to toggle the RGB module via on_click. Adds md_in_html to mkdocs.yml to support inline annotations inside list sub-items.
|
Caution Review failedPull request was closed or merged during review WalkthroughThis PR introduces a new tutorial page documenting how to build a button-controlled LED automation using ESPHome Device Builder. The tutorial walks users through triggering on button clicks and toggling RGB LEDs, includes embedded YAML configuration, installation steps, and testing verification. The site navigation and markdown extension are updated to support the new page. ChangesButton Automation Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
What does this implement/fix?
Adds a new Automations group under ESPHome Starter Kit in the sidebar, with a first tutorial: Button Controlled LEDs. The page walks readers through building an automation in the new ESPHome Device Builder GUI (no YAML by hand) so pressing the Button module toggles the RGB module.
The tutorial covers:
Effects are deliberately not covered yet because the GUI builder doesn't expose effect selection today.
mkdocs.ymlchanges:Automations:group underESPHome Starter Kitwith the tutorial wired upmd_in_htmltomarkdown_extensionsso the<div class="annotate" markdown>annotation pattern works for inline notes inside list items (the pattern recommended by the Material annotation docs for nested content)Screenshot placeholder for the hero image (
esphome-starter-kit-button-rgb-assembled.png) is left as a<!-- TODO -->comment in the page. Will drop the image in a follow-up.Types of changes
mkdocs.yml)Checklist:
devbranch (notmain)mkdocs servemkdocs.ymlmkdocs.ymlSummary by CodeRabbit
Release Notes